Add arguments_specs to roles #56
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@GomathiselviS Can you please rebase? Thanks. |
Certainly, I will mark it as a draft until the PR is ready for review. |
GomathiselviS
changed the title
abikouo
reviewed
Mar 13, 2024
There was a problem hiding this comment.
This documentation format is described here https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html#semantic-markup-within-module-documentation
| @@ -0,0 +1,3 @@ | |||
| --- | |||
| trivial: | |||
There was a problem hiding this comment.
I would rather prefer having this as a minor_changes
| azure_load_balancer_with_public_ip_resource_group: | ||
| description: | ||
| - Resource group on/from which the load balancer will reside. | ||
| - When `azure_load_balancer_with_public_ip_operation` is set to create, this resource group will be created if it does not exist. |
There was a problem hiding this comment.
Suggested change
| - When `azure_load_balancer_with_public_ip_operation` is set to create, this resource group will be created if it does not exist. | |
| - When O(azure_load_balancer_with_public_ip_operation) is set to create, this resource group will be created if it does not exist. |
| vnet_name: | ||
| description: | ||
| - Name of the existing azure virtual network where the network interface will reside. | ||
| - Required when `azure_manage_network_interface_operation`=create. |
There was a problem hiding this comment.
Suggested change
| - Required when `azure_manage_network_interface_operation`=create. | |
| - Required when O(azure_manage_network_interface_operation=create). |
| subnet_name: | ||
| description: | ||
| - Name of the existing azure subnet where the network interface will reside. | ||
| - Required when `azure_manage_network_interface_operation`=create. |
There was a problem hiding this comment.
Suggested change
| - Required when `azure_manage_network_interface_operation`=create. | |
| - Required when O(azure_manage_network_interface_operation=create). |
roles/azure_virtual_machine_with_public_ip/meta/argument_specs.yml
Outdated
Show resolved
Hide resolved
roles/azure_virtual_machine_with_public_ip/meta/argument_specs.yml
Outdated
Show resolved
Hide resolved
roles/azure_virtual_machine_with_public_ip/meta/argument_specs.yml
Outdated
Show resolved
Hide resolved
roles/azure_virtual_machine_with_public_ip/meta/argument_specs.yml
Outdated
Show resolved
Hide resolved
roles/azure_virtual_machine_with_public_ip/meta/argument_specs.yml
Outdated
Show resolved
Hide resolved
abikouo
approved these changes
Mar 25, 2024
alinabuzachis
approved these changes
Mar 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds argument_specs.yml to the roles to enable validation of arguments.
This aligns with https://github.com/ansible-collections/cloud-content-handbook/blob/main/Roles-arguments_validation.md and https://github.com/redhat-cop/automation-good-practices/tree/main/roles#argument-validation